Skip to content

fix(jest)!: default isolatedModules to true for faster compilation (fixes #1899)#2191

Merged
just-jeb merged 2 commits into
release/v22from
fix/1899-isolated-modules-default
Jun 4, 2026
Merged

fix(jest)!: default isolatedModules to true for faster compilation (fixes #1899)#2191
just-jeb merged 2 commits into
release/v22from
fix/1899-isolated-modules-default

Conversation

@just-jeb
Copy link
Copy Markdown
Owner

@just-jeb just-jeb commented Apr 27, 2026

PR Checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

[x] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Angular 19 introduced signals, new control flow syntax, and standalone-by-default components. With isolatedModules: false (today's default), ts-jest builds a full cross-file Program per test file, producing severe slowdowns — reports of 2-minute test runs ballooning to 15 minutes after the upgrade. jest-preset-angular has been recommending isolatedModules: true since v14.4.0 and ships it as the default in their A19+ presets.

Issue Number: #1899

What is the new behavior?

isolatedModules: true is set in the default per-project ts-jest transform config. Users can still override via their own jest.config.{js,ts,...}.

Does this PR introduce a breaking change?

[x] Yes
[ ] No

isolatedModules: true disallows certain TS patterns:

  • const enum cannot be inlined across files — must be regular enum or runtime-evaluated
  • Type-only re-exports require the type modifier (export type { X } rather than export { X } when X is a type)
  • Ambient const enum declarations from .d.ts files (uncommon) require preserveValueImports

These produce loud TS compile errors at test time, not silent miscompiles. Ships in the next major.

CHANGELOG migration note (draft)

BREAKING (jest): ts-jest isolatedModules now defaults to true. If your test suite uses const enum across files, or relies on type-only re-exports without the type modifier, you'll get TS compile errors. Either fix the call site (recommended — see TypeScript handbook) or restore the old behavior in your jest config:

transform: { '^.+\\.(ts|mjs|js|html)$': ['jest-preset-angular', { tsconfig: '<rootDir>/tsconfig.spec.json', isolatedModules: false }] }

Other information

Branch was force-pushed to drop the unrelated custom-esbuild changes that belonged in PR #2192. Only the jest commit remains.

Copy link
Copy Markdown
Owner Author

@just-jeb just-jeb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Includes unrelated changes from #2192

@just-jeb just-jeb force-pushed the fix/1899-isolated-modules-default branch 2 times, most recently from c66e849 to 2a9ef37 Compare May 17, 2026 14:19
just-jeb added a commit that referenced this pull request Jun 2, 2026
- spec §12: Karma deprecated-not-removed in v22; drop custom-webpack @22
  migration + hold #2260; add jest Vitest→Jest path; add custom-esbuild
  webpack-build guard; fix e2e fixtures
- spec §4.3/§5: custom-webpack ng-add-only; v22 breaking set = #2191+#2212
- 2c/2d checklist: #2260 off the v22 holds, Karma fixture via ng new, e2e cases
just-jeb added a commit that referenced this pull request Jun 3, 2026
just-jeb added a commit that referenced this pull request Jun 3, 2026
- spec §12: Karma deprecated-not-removed in v22; drop custom-webpack @22
  migration + hold #2260; add jest Vitest→Jest path; add custom-esbuild
  webpack-build guard; fix e2e fixtures
- spec §4.3/§5: custom-webpack ng-add-only; v22 breaking set = #2191+#2212
- 2c/2d checklist: #2260 off the v22 holds, Karma fixture via ng new, e2e cases
Houston (Jeb's AI) and others added 2 commits June 3, 2026 18:04
 #1899)

Angular 19 introduced signals, new control flow syntax, and standalone-by-default
components. These produce significantly more complex TypeScript that causes the
ts-jest language service (used when isolatedModules: false) to build a full
cross-file Program per test file, resulting in severe slowdowns (reports of
2 min → 15 min test runs).

Root cause: when isolatedModules is false (previously the implicit default),
ts-jest instantiates a TypeScript LanguageService and rebuilds a full Program
for each file. Angular 19+'s richer type surface makes this path prohibitively
slow.

Fix: set isolatedModules: true in the builder's default transformer options.
This switches ts-jest to its fast per-file transpile path, matching the
recommendation from jest-preset-angular's own example apps since v14.4.0.

Cross-file type checking is better served by tsc --noEmit or ng build.
Users who need the previous behaviour can opt out in their jest.config.ts:

  transform: {
    '^.+\.(ts|js|mjs|html|svg)$': ['jest-preset-angular', { isolatedModules: false }]
  }

BREAKING CHANGE: isolatedModules now defaults to true. This disables
cross-file TypeScript type checking during jest runs. Targeted for the
next major version.
…on test

Remove isolatedModules:true assertions from the unit spec — they tested
implementation details (object shape), not user-visible behavior. Replace
with targeted assertions on tsconfig path resolution, which is the actual
behavioral contract of the resolver.

Add isolated-modules-default integration test entry that proves Angular
component tests still pass end-to-end with isolatedModules:true active,
providing the behavioral regression guard for #1899.
@just-jeb just-jeb force-pushed the fix/1899-isolated-modules-default branch from d1a012d to 9733a26 Compare June 3, 2026 16:04
@just-jeb just-jeb changed the base branch from master to release/v22 June 3, 2026 16:08
@just-jeb just-jeb changed the title fix(jest): default isolatedModules to true for faster compilation (fixes #1899) fix(jest)!: default isolatedModules to true for faster compilation (fixes #1899) Jun 4, 2026
just-jeb added a commit that referenced this pull request Jun 4, 2026
…webpack (#2267)

* docs(schematics): add v22 builder ng-add + ng-update design spec

* docs(schematics): cover v22-held breaking PRs (#2191/#2212) and MIGRATION.MD pairing

* docs(schematics): add Plan 0 — common/schematics core + packaging

* docs(schematics): add Plans 01-03 — jest, custom-esbuild, custom-webpack

Builder implementation plans referencing Plan 0's locked common/schematics
API contract. Reviewed for consistency: all import the shared helpers, none
redefine them, no raw fs (tree-based edits only).

* docs(schematics): add v17→v22 migration coverage caveat + 2c/2d execution checklist

- jest plan: document the stepwise-through-v21 skip + single-step old→22 flow
  and RC-time multi-major ng update validation
- new 2c/2d checklist: holds rebase, MIGRATION.MD pairing, RC validations,
  and the two e2e testing gaps (ng add integration, jest @21 post-migration smoke)

* docs(schematics): amend design for Karma roadmap (not removed in v22)

- spec §12: Karma deprecated-not-removed in v22; drop custom-webpack @22
  migration + hold #2260; add jest Vitest→Jest path; add custom-esbuild
  webpack-build guard; fix e2e fixtures
- spec §4.3/§5: custom-webpack ng-add-only; v22 breaking set = #2191+#2212
- 2c/2d checklist: #2260 off the v22 holds, Karma fixture via ng new, e2e cases

* docs(schematics): apply §12 amendments to builder plans

- jest (Plan 01): add Vitest→Jest ng-add path (Task 4b), keep Karma→Jest
- custom-esbuild (Plan 02): add webpack-build guard + --from-webpack (Task 3b)
- custom-webpack (Plan 03): drop @22 Karma-removal migration, ng-add only

Reviewed: no shared-helper redefinition, no raw fs in schematic code,
webpack @22 migration fully removed (remaining refs assert its absence).

* docs(schematics): add Plan 04 — schematics integration/e2e tests

ng add e2e per builder (jest Karma→Jest + Vitest→Jest, esbuild build +
webpack guard, webpack scaffold) via npm pack→ng add tarball into the existing
integration matrix; jest @21 post-migration build smoke; RC multi-major
ng update validation.

* build(common): add schematics subpath packaging (tsconfig + exports + copy)

* feat(common): add schematics version helpers

* feat(common): add SchematicTestHarness for schematics unit tests

Also stubs ESM-only `ora` (via @angular-devkit/schematics task executor
chain) with a moduleNameMapper in jest-ut.config.js, and resolves
@schematics/angular/collection.json via package.json to bypass the
exports map (required in Node 22+).

* feat(common): add workspace detection helpers for schematics

* feat(common): add composable schematics rule factories

* feat(common): export schematics core via ./schematics subpath

* build(jest): add schematics packaging (tsconfig + fields + copy)

* feat(jest): add ng-add collection + schema (project flag only)

* feat(jest): ng-add adds jest stack and rewrites test target

* feat(jest): declare ng-update migrations manifest (v21, v22)

* feat(jest): v21 migration bumps deps and applies Node16 tsconfig

* feat(jest): v22 advisory migration (isolatedModules, coverage path)

* build(custom-esbuild): add schematics packaging (tsconfig + ng-add fields + copy)

* feat(custom-esbuild): add ng-add collection + schema manifests

* feat(custom-esbuild): ng-add rewrites build/serve preserving options

* feat(custom-esbuild): ng-add guards webpack builds, adds --from-webpack (spec §12.3)

* feat(custom-esbuild): ng-add auto-rewrites Vitest test target with buildTarget

* feat(custom-esbuild): ng-add leaves Karma/Jest tests, logs unit-test advisory

* feat(custom-esbuild): ng-add --unit-test force-creates Vitest target

* test(custom-esbuild): assert ng-add idempotency

* build(custom-esbuild): verify schematics build

* build(custom-webpack): add schematics packaging (tsconfig + ng-add field)

* feat(custom-webpack): add ng-add schema (project flag, no prompts)

* feat(custom-webpack): add starter webpack.config scaffold template

* feat(custom-webpack): add ng-add (build/serve rewrite + config scaffold)

* test(custom-webpack): verify schematics build + no-migrations invariant

* fix(jest): add WorkspaceDefinition casts and JsonValue fixes for schematics tsc

* test(schematics): add local-only ng add e2e harness helpers

* build(schematics): use Node16 module resolution for schematics build

The schematics tsconfig used module:commonjs + moduleResolution:node (node10).
node10 is deprecated in TypeScript 6 (Angular 22) AND ignores package exports maps —
the latter is why each package's schematics tsconfig carried a 'paths' override just
to resolve @angular-builders/common/schematics.

Align with the main builder tsconfig (module/moduleResolution Node16): all packages are
CJS (no type:module), so Node16 still emits CommonJS as schematics require, while honoring
exports maps. This drops the paths workaround in all three packages and needs no
deprecation suppression. Add types:[node] since TS6 no longer auto-includes node ambients.

* test(schematics): generate ng-add e2e fixtures inline, default to no-install collection run

ng add e2e now generates the target app inline with the workspace CLI (ng new) instead of
committing a fresh-scaffold fixture — self-describing and immune to fixture drift across
Angular majors. Default ng add path resolves the collection from the workspace-linked
package with --skip-install (the schematic under test runs fully; no package-manager step,
so it can't mutate the symlinked node_modules). npm-pack tarball path kept behind
useTarball:true for a future isolated-install CI.

* fix(schematics): handle Angular 22 unified :unit-test runner model

Angular 22 expresses Karma and Vitest as the same @angular/build:unit-test builder,
distinguished by an options.runner ('karma' | 'vitest') field, rather than a dedicated
:karma builder (which still exists for webpack projects). The schematics, written for the
v21 model, broke on v22:

- detectTestBuilder classified every :unit-test target as Vitest, so Karma on a default
  (esbuild) v22 app was invisible. Now it reads options.runner for :unit-test builders and
  keeps the :karma suffix branch for webpack projects.
- jest ng-add merged {zoneless} onto the previous target's options, leaving the foreign
  builder's runner/buildTarget behind; the Jest builder then forwarded --runner to the Jest
  CLI ('Runner is not a constructor'). setBuilderForTarget gains an opt-in replaceOptions
  (default still merges, preserving other callers); jest ng-add uses it to start from a clean
  Jest option set.

Surfaced by the Plan 04 ng-add e2e (ng new --test-runner karma -> ng add -> ng test).

* test(jest): add Karma->Jest ng add e2e (inline fixture, real ng test)

* test(jest): add Vitest->Jest ng add e2e (ng build + ng test green)

* test(custom-esbuild): add build/serve rewrite ng add e2e

* test(custom-esbuild): add webpack-build guard ng add e2e

* test(custom-webpack): add build/serve rewrite + scaffold ng add e2e

* test(jest): add @21 migration post-build smoke; fix testPathPatterns string->array

The @21 migration renamed testPathPattern -> testPathPatterns but carried the value over
verbatim. Jest 30's testPathPatterns is a string array, so a migrated config failed builder
schema validation ('testPathPatterns must be array') at ng test. Wrap a carried-over string
in an array. Surfaced by the new ng update --migrate-only post-build smoke (Plan 04 Task 6),
which seeds a pre-21 config on an inline-generated app, runs the migration, then ng build + ng test.

* docs(runbook): record RC-validated multi-major ng update window

* test(schematics): neutralise package manager during ng add via PATH shim

The ng add collection run can't use --skip-install (ng add forwards it to the schematic, whose
schema rejects unknown options). Instead prepend a no-op npm/yarn/pnpm shim to PATH for the ng add
spawn so the schematic's NodePackageInstallTask runs harmlessly — it cannot write through the
workdir's node_modules symlink into the workspace. Every tree transform still happens; ng build/test
afterwards resolve from the workspace-linked modules.

* fix(custom-webpack): declare @angular-devkit/schematics and @schematics/angular deps

custom-webpack's ng-add imports from both packages but didn't declare them, relying on them
being present transitively via the user's @angular/cli install. Declare them explicitly
(matching jest and custom-esbuild) so ng add resolves regardless of hoisting.
@just-jeb just-jeb merged commit d3a6314 into release/v22 Jun 4, 2026
47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant